home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / rmdir < prev    next >
Text File  |  2001-03-21  |  970b  |  30 lines
  1. Synopsis:
  2.    $rmdir(<directory> [<directory> ...])
  3.  
  4. Technical:
  5.    This function unlinks the specified directories from the filesystem.  As
  6.    with the normal shell mechanism, the directory must be empty before it
  7.    can be removed.  Tilde-expansion is permitted.
  8.  
  9. Practical:
  10.    One practical use for this function might be to remove any temporary
  11.    directories created by a script installation program.  Other than that,
  12.    there aren't many common uses for this function.
  13.  
  14. Returns:
  15.     0   successfully removed all directories given
  16.    >0   number of directories that could not be removed
  17.  
  18. Examples:
  19.    $rmdir(~/temp)             returns 0 if ~/temp is empty
  20.    $rmdir(~/temp /etc)        probably will return 1, unless you're root
  21.  
  22. See Also:
  23.    mkdir(6)
  24.  
  25. Bugs:
  26.    When $rmdir() fails to some extent, it shows how many directories could
  27.    not be removed, but does not say which ones.  This isn't necessarily a
  28.    bug, but it could be bothersome.
  29.  
  30.